widgets.brease.ContentControl

Widget Description

short: Widget to load a content
de: Das ContentControl-Widget ermöglicht das Laden eines Contents in einem Widget
en: The widget provides an optional configurable contentId property where the user can reference a content which is loaded when the widget is shown on the client

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
contentId reference to a content; this content is loaded immediately Behavior ContentReference false false false false false true
deactivate defines, if the loaded content is deactivated, when the widget is not shown Behavior Boolean false false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
visible change visibility Behavior Boolean true true false false false false true
zoomMode Behavior ZoomType original false false false false false true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 100% false false false true true
width outer width of widget Size 100% false false false true true

Events

name description arguments
FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

VisibilityChanged Fired when visibility of widget changes.
  • visibility: Boolean

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
GetContentId Returns the contentId of the current loaded content. Returns empty string, if no content is loaded.
LoadContent Asynchronous method to load a content into the widget.
  • contentId: ContentReference

    id of content

If actions (=method with iatStudioExposed) use a deferred object as return value, ActionController expects the deferred object to be resolved in any case. Return values in deferred.resolve(success, result) are: {Boolean} success: indicator if method was successful {Boolean} result: the actual return value of the method (in our case result == success) {Object} contentData: additional info about contents to be activated or deactivated {ContentReference[]} contentData.activate: contents to be activated {ContentReference[]} contentData.deactivate: contents to be deactivated
SetVisible Sets the state of property «visible»
  • value: Boolean

UnloadContent Asynchronous method to unload the current content of the widget. If actions (=method with iatStudioExposed) use a deferred object as return value, ActionController expects the deferred object to be resolved in any case. Return values in deferred.resolve(success, result, contentData) are: {Boolean} success: indicator if method was successful {Boolean} result: the actual return value of the method (in our case result == success) {Object} contentData: additional info about contents to be activated or deactivated {ContentReference[]} contentData.activate: contents to be activated {ContentReference[]} contentData.deactivate: contents to be deactivated